fix(container-reference): add/update API reference blocks #12511
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ArmandPhilippot
added
improve or update documentation
✅ Deploy Preview for astro-docs-2 ready!Built without sensitive environment variables
To edit notification comments on pull requests, go to your Netlify project configuration. |
Lunaria Status Overview🌕 This pull request will trigger status changes. Learn moreBy default, every PR changing files present in the Lunaria configuration's You can change this by adding one of the keywords present in the Tracked Files
Warnings reference
|
ArmandPhilippot
added a commit
to ArmandPhilippot/astro-docs
that referenced
this pull request
Oct 7, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description (required)
Updates
container-reference.mdx(no text changes, only API documentation) with the following changes:create()typestreamingdefaultrenderersdefaultrenderToString()typerenderToResponse()typerouteTypetype: the type we show is incomplete, we are missingredirectandfallback. Since the type is public, I think we can just useRouteTypeboth inContainerRenderOptionsand the option description to prevent an outdated type.partialtoContainerRenderOptions(the option is already documented)Note:
AstroContainerOptionsis incomplete based on the source code but I recall at least one of the available option do not work (withastro/astro#11585) so it is probably fine to leave it as it is for now!Related issues & labels (optional)
consistency/formatting,improve or update documentation